<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Selection Choice Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">SelectionChoice Structure</p>
<h1>Structure Overview</h1>
<div class="section-text">
Describes one item in a static parameter selection list.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Selection Choice</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-label">label</a></dt>
<dd>An externalizable label for the choice.</dd>
<dt><a href="#Property-labelID">labelID</a></dt>
<dd></dd>
<dt><a href="#Property-value">value</a></dt>
<dd>The parameter value for this choice.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>A static selection list defines a set of property choice 
values. Each choice provides two values: an internal value and a display value. 
For example, the display values might be &quot;Residential&quot;, &quot;Commercial&quot;, and 
&quot;Government&quot; while the corresponding parameter values are &quot;R&quot;, &quot;C&quot;, and &quot;G&quot;. 
Display values can be localized.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-label">label Property</a></h2>

<p class="section-text">An externalizable label for the choice.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Label</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>An externalizable label for the choice. If omitted, then 
the internal value is shown as the label.</p></div>

<hr>
<h2><a name="Property-labelID">labelID Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Label Resource Key</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>


<hr>
<h2><a name="Property-value">value Property</a></h2>

<p class="section-text">The parameter value for this choice.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#literalString">literalString</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>Yes</td></tr>
<tr><td>Display Name:</td>
<td>Value</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The parameter value for this choice. This is the value 
passed to the report when the user selects this choice. The value must agree 
with the parameter data type. The value cannot be localized.</p></div>
</body>
</html>
